fix: coerce by_alias to bool in model_dump to prevent TypeError with pydantic v2#2924
Open
carlosinfantes wants to merge 2 commits intoopenai:mainfrom
Open
fix: coerce by_alias to bool in model_dump to prevent TypeError with pydantic v2#2924carlosinfantes wants to merge 2 commits intoopenai:mainfrom
carlosinfantes wants to merge 2 commits intoopenai:mainfrom
Conversation
added 2 commits
March 3, 2026 20:05
…emory" The SDK declares prompt_cache_retention with Literal["in-memory", "24h"] (hyphen), but the API rejects "in-memory" with a 400 and only accepts "in_memory" (underscore). Fixes openai#2883
…pydantic v2 model_dump() passes by_alias=None to pydantic's model_dump(), which causes pydantic-core's Rust serializer to raise TypeError since it does not accept None for the by_alias parameter. This crashes any API call when the openai logger has DEBUG level enabled. Fixes openai#2921
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
model_dump()inopenai/_compat.pypassesby_alias=Noneto pydantic'smodel_dump(), which causes pydantic-core's Rust serializer to raiseTypeError: argument 'by_alias': 'NoneType' object cannot be converted to 'PyBool'.This crashes any API call when the
openailogger hasDEBUGlevel enabled, because_build_request()callsmodel_dump(options, exclude_unset=True)without passingby_alias, so it defaults toNone.Fix
Coerce
by_aliastoboolbefore passing to pydantic'smodel_dump():bool(None)evaluates toFalse, which preserves the expected default behavior.File changed
src/openai/_compat.py(line 152)Fixes #2921